Resource OperationDefinition/FHIR Server from package hl7.fhir.us.davinci-deqm#current (63 ms)

Resources that use this resource

CapabilityStatement
gic-client	Gaps In Care Client CapabilityStatement
gic-server	Gaps In Care Server CapabilityStatement

Resources that this resource uses

No resources found

Narrative

Note: links and images are rebased to the (stated) source

Source

{
  "resourceType" : "OperationDefinition",
  "id" : "care-gaps",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition care-gaps</b></p><a name=\"care-gaps\"> </a><a name=\"hccare-gaps\"> </a><a name=\"care-gaps-en-US\"> </a><p>URL: [base]/Measure/$care-gaps</p><p>URL: [base]/Measure/[id]/$care-gaps</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>periodStart</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#date\">date</a></td><td/><td><div><p>The start of a <a href=\"index.html#glossary\">gaps through period</a>. This may be the start of the measurement period defined by a measure, or a customized desired performance period start date determined by a payer, a provider, a measure program, and etc.</p>\n</div></td></tr><tr><td>IN</td><td>periodEnd</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#date\">date</a></td><td/><td><div><p>The end of a <a href=\"index.html#glossary\">gaps through period</a> (the gaps through date). The gaps through date could be a past date or a future date.  For example, today's date is 2020-06-18, 1) if periodEnd date is 2020-09-30, it returns gaps through 2020-09-30, and 2) if the periodEnd date is 2020-05-31, it returns gaps through 2020-05-31.</p>\n</div></td></tr><tr><td>IN</td><td>topic</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#token\">token</a>)</td><td/><td><div><p>The category of the measures that is of interest for the care gaps report. This references the <a href=\"https://www.hl7.org/fhir/measure-definitions.html#Measure.topic\">topic</a> element in the <a href=\"https://www.hl7.org/fhir/measure.html\">Measure</a> resource. Examples of topic may be screening measures, HEDIS measure domains, chronic disease measures. For example, setting topic to be a screening caregory will run care gaps on all screening measures. Topic may also be a &quot;value set&quot; that is defined with a list of domains/categories, etc. Topic examples: &quot;screening&quot;, &quot;pediatric&quot;. When multiple topics are provided, it is expected to be union of measures in those topics. Note that the type of this parameter is a string with a search type of <a href=\"https://www.hl7.org/fhir/search.html#token\">token</a>, so the $care-gaps operation has only simple input parameters and may be invoked using GET.</p>\n</div></td></tr><tr><td>IN</td><td>subject</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#reference\">reference</a>)</td><td/><td><div><p>Subject will be a reference to either Patient <a href=\"http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-patient\">QI Core Patient</a> or Group <a href=\"StructureDefinition-gaps-group-deqm.html\">DEQM Gaps In Care Group Profile</a>. Must provide either Patient/123 or Group/123, cannot simply provide 123. If only 123 is provided, then the operation would not know if it is a Patient reference or a Group reference.</p>\n</div></td></tr><tr><td>IN</td><td>subjectGroup</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/group.html\">Group</a></td><td/><td><div><p>Subject for which the gaps in care report will be created is provided as a Group resource.</p>\n</div></td></tr><tr><td>IN</td><td>parameters</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/parameters.html\">Parameters</a></td><td/><td><div><p>Any input parameters for the Measure evaluation. If the measure uses CQL, the parameter types are mapped to CQL as specified in the Parameters and Data Requirements section of the Using CQL with FHIR Implementation Guide. Any parameters defined in this input will be bound by name to parameters defined in the logic library referenced from library element of the Measure. If a parameter appears more than once in the input Parameters resource, it is represented with a List in the input CQL. If a parameter has parts, it is represented as a Tuple in the input CQL.</p>\n</div></td></tr><tr><td>IN</td><td>practitioner</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#reference\">reference</a>)</td><td/><td><div><p>Reference to a practitioner <a href=\"https://hl7.org/fhir/us/qicore/StructureDefinition-qicore-practitioner.html\">QI Core Practitioner</a> for which the gaps in care report will be created. For a practitioner focused gaps in care report, this is a required In Parameter. The Server needs to make sure that practitioner is authorized to get the gaps in care report for and know what measures the practitioner are eligible or qualified.</p>\n</div></td></tr><tr><td>IN</td><td>organization</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#reference\">reference</a>)</td><td/><td><div><p>Reference to an organization <a href=\"http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-organization\">QI Core Organization</a> for which the gaps in care report will be created. For a provider organization focused gaps in care report, this is a required In Parameter.</p>\n</div></td></tr><tr><td>IN</td><td>organizationResource</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/organization.html\">Organization</a></td><td/><td><div><p>Organization for which the gaps in care report will be created is provided as an Organization resource.</p>\n</div></td></tr><tr><td>IN</td><td>status</td><td/><td>1..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td><a href=\"ValueSet-gaps-status.html\">DEQM Gaps In Care Gap Status Value Set</a> (Extensible)</td><td><div><p>Indicates status of a care gap. For all <a href=\"index.html#glossary\">open, prospective, and closed gaps</a>, three seperate status parameters must be provided. For a positive proportion measure, gap means the patient is not in the numerator. For an inverse (negative) proportion measure (e.g., Diabetes: Hemoglobin A1c (HbA1c) Poor Control (&gt; 9%)), gap means the patient is in the numerator.</p>\n</div></td></tr><tr><td>IN</td><td>measureId</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#id\">id</a></td><td/><td><div><p>The id of a Measure resource that is on the server for which the gaps in care report will be created. E.g., the id of the Measure resource for Breast Cancer Screening measure.</p>\n</div></td></tr><tr><td>IN</td><td>measureIdentifier</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#token\">token</a>)</td><td/><td><div><p>The business identifier of a measure for which the gaps in care will be reported. E.g., CMS125 is a CMS assigned identifier for the Breast Cancer Screening eCQM in their system. Note that the type of this parameter is a string with a search type of <a href=\"https://www.hl7.org/fhir/search.html#token\">token</a>, so the $care-gaps operation has only simple input parameters and may be invoked using GET.</p>\n</div></td></tr><tr><td>IN</td><td>measureUrl</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#canonical\">canonical</a></td><td/><td><div><p>The URL of a measure for which the gaps in care report will be created. A measure URL is specified in the <a href=\"https://www.hl7.org/fhir/measure-definitions.html#Measure.url\">url</a> element of the Measure resource. The measure URL remains the same when the measure is stored on different servers.</p>\n</div></td></tr><tr><td>IN</td><td>measureResource</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/measure.html\">Measure</a></td><td/><td><div><p>The measure for which the gaps in care report will be created is provided as a Measure resource.</p>\n</div></td></tr><tr><td>IN</td><td>measure</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#reference\">reference</a>)</td><td/><td><div><p>The measure for which the gaps in care report will be created. This parameter is only required when the operation is invoked on the resource type, it is not used when invoking the operation on a Measure instance</p>\n</div></td></tr><tr><td>IN</td><td>manifest</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#canonical\">canonical</a></td><td/><td><div><p>Specifies an asset-collection library that provides dependency version resolution and expansion rules for the operation. See the description of manifest in the Canonical Resource Management Infrastructure IG for a complete description of how manifest values are used to provide defaults for dependency version resolution and expansion parameters. Parameters specified directly in the operation override behaviors specified by the manifest parameter. In general, if this parameter is supplied, it is expected to be used in nested operation calls. For example, in evaluating a measure, if the expansion of a value set is required, this parameter SHALL be supplied to that expansion.</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>The $care-gaps operation returns <a href=\"https://www.hl7.org/fhir/parameters.html\">Parameters</a> resource, containing zero or more document bundles that conform to the <a href=\"StructureDefinition-gaps-bundle-deqm.html\">DEQM Gaps In Care Bundle Profile</a>. Note that the result of the $care-gaps operation must be returned using the Parameters resource, even when the result contains only one bundle, because the cardinality of the return parameter is specified as 0..*.</p>\n</div></td></tr></table><div><p>The effect of invoking this operation is to calculate a measure or a set of measures based on the In Parameters provided and to return Parameters resource containing one or more document bundles describing the gaps in care results         of each measure, for the specified gaps through period and for the given subject (a patient or a group of patients). Because more than one bundle may be returned, the operation parameter must always be returned.  Note that it is up to the Server to determine whether         or not the generated gaps in care report is persisted. If the Server does not persist the results, the operation does not affect state and can be invoked with a GET. Note that this operation is intended to replace the existing base Measure $care-gaps operation in FHIR R5.</p>\n</div></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "cqi"
    }
  ],
  "url" : "http://hl7.org/fhir/us/davinci-deqm/OperationDefinition/care-gaps",
  "version" : "5.0.0",
  "name" : "CareGaps",
  "title" : "Care Gaps Operation",
  "status" : "active",
  "kind" : "operation",
  "date" : "2021-04-23",
  "publisher" : "HL7 International / Clinical Quality Information",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/cqi"
        }
      ]
    }
  ],
  "description" : "The care-gaps operation is used to determine gaps in care for a specified gaps through period based on the results of quality measures.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US"
        }
      ]
    }
  ],
  "code" : "care-gaps",
  "comment" : "The effect of invoking this operation is to calculate a measure or a set of measures based on the In Parameters provided and to return Parameters resource containing one or more document bundles describing the gaps in care results         of each measure, for the specified gaps through period and for the given subject (a patient or a group of patients). Because more than one bundle may be returned, the operation parameter must always be returned.  Note that it is up to the Server to determine whether         or not the generated gaps in care report is persisted. If the Server does not persist the results, the operation does not affect state and can be invoked with a GET. Note that this operation is intended to replace the existing base Measure $care-gaps operation in FHIR R5.",
  "base" : "http://hl7.org/fhir/OperationDefinition/Measure-care-gaps",
  "resource" : [
    "Measure"
  ],
  "system" : false,
  "type" : true,
  "instance" : true,
  "parameter" : [
    {
      "name" : "periodStart",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The start of a [gaps through period](index.html#glossary). This may be the start of the measurement period defined by a measure, or a customized desired performance period start date determined by a payer, a provider, a measure program, and etc.",
      "type" : "date"
    },
    {
      "name" : "periodEnd",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The end of a [gaps through period](index.html#glossary) (the gaps through date). The gaps through date could be a past date or a future date.  For example, today's date is 2020-06-18, 1) if periodEnd date is 2020-09-30, it returns gaps through 2020-09-30, and 2) if the periodEnd date is 2020-05-31, it returns gaps through 2020-05-31.",
      "type" : "date"
    },
    {
      "name" : "topic",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "The category of the measures that is of interest for the care gaps report. This references the [topic](https://www.hl7.org/fhir/measure-definitions.html#Measure.topic) element in the [Measure](https://www.hl7.org/fhir/measure.html) resource. Examples of topic may be screening measures, HEDIS measure domains, chronic disease measures. For example, setting topic to be a screening caregory will run care gaps on all screening measures. Topic may also be a \"value set\" that is defined with a list of domains/categories, etc. Topic examples: \"screening\", \"pediatric\". When multiple topics are provided, it is expected to be union of measures in those topics. Note that the type of this parameter is a string with a search type of [token](https://www.hl7.org/fhir/search.html#token), so the $care-gaps operation has only simple input parameters and may be invoked using GET.",
      "type" : "string",
      "searchType" : "token"
    },
    {
      "name" : "subject",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Subject will be a reference to either Patient [QI Core Patient](http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-patient) or Group [DEQM Gaps In Care Group Profile](StructureDefinition-gaps-group-deqm.html). Must provide either Patient/123 or Group/123, cannot simply provide 123. If only 123 is provided, then the operation would not know if it is a Patient reference or a Group reference.",
      "type" : "string",
      "searchType" : "reference"
    },
    {
      "name" : "subjectGroup",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Subject for which the gaps in care report will be created is provided as a Group resource.",
      "type" : "Group"
    },
    {
      "name" : "parameters",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Any input parameters for the Measure evaluation. If the measure uses CQL, the parameter types are mapped to CQL as specified in the Parameters and Data Requirements section of the Using CQL with FHIR Implementation Guide. Any parameters defined in this input will be bound by name to parameters defined in the logic library referenced from library element of the Measure. If a parameter appears more than once in the input Parameters resource, it is represented with a List in the input CQL. If a parameter has parts, it is represented as a Tuple in the input CQL.",
      "type" : "Parameters"
    },
    {
      "name" : "practitioner",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Reference to a practitioner [QI Core Practitioner](https://hl7.org/fhir/us/qicore/StructureDefinition-qicore-practitioner.html) for which the gaps in care report will be created. For a practitioner focused gaps in care report, this is a required In Parameter. The Server needs to make sure that practitioner is authorized to get the gaps in care report for and know what measures the practitioner are eligible or qualified.",
      "type" : "string",
      "searchType" : "reference"
    },
    {
      "name" : "organization",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Reference to an organization [QI Core Organization](http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-organization) for which the gaps in care report will be created. For a provider organization focused gaps in care report, this is a required In Parameter.",
      "type" : "string",
      "searchType" : "reference"
    },
    {
      "name" : "organizationResource",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Organization for which the gaps in care report will be created is provided as an Organization resource.",
      "type" : "Organization"
    },
    {
      "name" : "status",
      "use" : "in",
      "min" : 1,
      "max" : "*",
      "documentation" : "Indicates status of a care gap. For all [open, prospective, and closed gaps](index.html#glossary), three seperate status parameters must be provided. For a positive proportion measure, gap means the patient is not in the numerator. For an inverse (negative) proportion measure (e.g., Diabetes: Hemoglobin A1c (HbA1c) Poor Control (> 9%)), gap means the patient is in the numerator.",
      "type" : "code",
      "binding" : {
        "strength" : "extensible",
        "valueSet" : "http://hl7.org/fhir/us/davinci-deqm/ValueSet/gaps-status"
      }
    },
    {
      "name" : "measureId",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "The id of a Measure resource that is on the server for which the gaps in care report will be created. E.g., the id of the Measure resource for Breast Cancer Screening measure.",
      "type" : "id"
    },
    {
      "name" : "measureIdentifier",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "The business identifier of a measure for which the gaps in care will be reported. E.g., CMS125 is a CMS assigned identifier for the Breast Cancer Screening eCQM in their system. Note that the type of this parameter is a string with a search type of [token](https://www.hl7.org/fhir/search.html#token), so the $care-gaps operation has only simple input parameters and may be invoked using GET.",
      "type" : "string",
      "searchType" : "token"
    },
    {
      "name" : "measureUrl",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "The URL of a measure for which the gaps in care report will be created. A measure URL is specified in the [url](https://www.hl7.org/fhir/measure-definitions.html#Measure.url) element of the Measure resource. The measure URL remains the same when the measure is stored on different servers.",
      "type" : "canonical"
    },
    {
      "name" : "measureResource",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "The measure for which the gaps in care report will be created is provided as a Measure resource.",
      "type" : "Measure"
    },
    {
      "name" : "measure",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "The measure for which the gaps in care report will be created. This parameter is only required when the operation is invoked on the resource type, it is not used when invoking the operation on a Measure instance",
      "type" : "string",
      "searchType" : "reference"
    },
    {
      "name" : "manifest",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Specifies an asset-collection library that provides dependency version resolution and expansion rules for the operation. See the description of manifest in the Canonical Resource Management Infrastructure IG for a complete description of how manifest values are used to provide defaults for dependency version resolution and expansion parameters. Parameters specified directly in the operation override behaviors specified by the manifest parameter. In general, if this parameter is supplied, it is expected to be used in nested operation calls. For example, in evaluating a measure, if the expansion of a value set is required, this parameter SHALL be supplied to that expansion.",
      "type" : "canonical"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 0,
      "max" : "*",
      "documentation" : "The $care-gaps operation returns [Parameters](https://www.hl7.org/fhir/parameters.html) resource, containing zero or more document bundles that conform to the [DEQM Gaps In Care Bundle Profile](StructureDefinition-gaps-bundle-deqm.html). Note that the result of the $care-gaps operation must be returned using the Parameters resource, even when the result contains only one bundle, because the cardinality of the return parameter is specified as 0..*.",
      "type" : "Bundle"
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.